home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / INSTALL < prev    next >
Text File  |  2004-03-24  |  3KB  |  75 lines
  1. $Id: INSTALL,v 1.5.2.1 2003/07/30 00:39:37 CelloG Exp $
  2.  
  3. phpDocumentor Installation instructions
  4. ---------------------------------------
  5.  
  6. phpDocumentor is very easy to install.  The hardest part is installing PHP
  7. and possibly a Web Server, if you plan to use the web interface phpdoc.php
  8.  
  9. To install phpDocumentor, use a compression program to decompress the
  10. contents to a directory, preserving internal directory structure of the
  11. archive.  If you wish to use the web interface, you must unzip the
  12. archive into a subdirectory accessible by the web server.
  13.  
  14. PEAR installation
  15. -----------------
  16. This is by far the easiest way to install phpDocumentor.  Included in this
  17. release is a package.xml file.  Simply run
  18.  
  19. pear install /path/to/phpDocumentor-1.2.2/package.xml
  20.  
  21. on Windows:
  22.  
  23. pear install C:\path\to\phpDocumentor-1.2.2\package.xml
  24.  
  25. If you have an existing install, pear uninstall PhpDocumentor first.
  26.  
  27. PhpDocumentor contains a new filerole, publicweb, that requires the latest
  28. version of the pear package, so be sure to pear upgrade PEAR before
  29. attmempting to install
  30.  
  31. To use the web interface, browse to <publicwebdir>\PhpDocumentor\index.html
  32.  
  33. Command-line interface installation and usage instructions
  34. ----------------------------------------------------------
  35. To use phpDocumentor as a command-line interface, you need to install PHP
  36. version 4.1.0 or greater.
  37.  
  38. *IMPORTANT* any version of PHP below 4.1.0 will not work with version 1.2.0 of
  39. phpDocumentor!!!  To use the new tokenizer-based parser, you must have php 4.3.0
  40.  
  41. Windows
  42. -------
  43. You need the cli version of PHP (php-cli.exe or cli/php.exe in 4.3.0).
  44. Either run phpDocumentor from the directory that PHP resides in, or put
  45. php.exe in your DOS PATH enviroment variable.  The simplest usage of phpDocumentor is:
  46.  
  47. C:\>php.exe "C:\Path\To\phpdoc" -t targetdir -o HTML:default:default -d parsedir
  48.  
  49. where targetdir is the directory you wish phpDocumentor to create output,
  50. and parsedir is the directory you wish to parse.
  51.  
  52. Unix
  53. ----
  54. Make sure that the cgi version of PHP is in your path.  The simplest usage
  55. of phpDocumentor is:
  56.  
  57. phpdoc -t targetdir -o HTML:default:default -d parsedir
  58.  
  59. You can use makedoc.sh. Simple copy it to your project path and edit it.
  60. When you wish to (re)build your project's documentation, simple run it.
  61.  
  62.  
  63. Web interface installation and usage instructions
  64. -------------------------------------------------
  65. To use phpDocumentor as a web interface, you need to install a Web server
  66. and configure it, as well as install PHP version 4.1.0 or greater.  Consult
  67. the documentation of your webserver and of PHP for installation support.
  68.  
  69. Windows and Unix
  70. ----------------
  71. open a web browser and browse to phpdoc.php at the location that you set up.
  72. Instructions are in the web interface.
  73.  
  74. vim: set expandtab :
  75.